home *** CD-ROM | disk | FTP | other *** search
/ Turnbull China Bikeride / Turnbull China Bikeride - Disc 2.iso / BARNET / FREENET / CROFT / QEDIT058 / !Qedit / !Help < prev    next >
Text File  |  1998-02-25  |  19KB  |  496 lines
  1.                         -------------------------
  2.                         |  Help file for Qedit  |
  3.                         |  A ka9q queue editor  |
  4.                         |                       |
  5.                         | © David Croft, 1995-8 |
  6.                         -------------------------
  7.  
  8.        **
  9.        *  This version has been developed by Joseph Heenan,  *
  10.        *          to whom I am immensely grateful.           *
  11.                                                             **
  12.  
  13.  
  14. This document is divided into thirteen sections:
  15.  
  16. 1.  Copyright and Licence
  17. 2.  Requirements
  18. 3.  Running Qedit
  19. 4.  The main window
  20. 5.  Messages "on hold"
  21. 6.  Re-editing messages
  22. 7.  Other options
  23. 8.  Configuration
  24. 9.  Known problems
  25. 10. Wish-list
  26. 11. Release history
  27. 12. Acknowledgements
  28. 13. Contact addresses
  29.  
  30. In this document, the term "message" is used to refer to both "electronic
  31. mail messages" and "Usenet news articles".
  32.  
  33.  
  34. 1. Copyright and Licence
  35. ------------------------
  36.  
  37. Qedit is Copyright 1995, 1996 and 1997 by David Croft. All Rights Reserved.
  38. Additional code Copyright 1997 by Joseph Heenan.
  39.  
  40. You may copy and use this program freely within the limitations outlined below:
  41.  
  42.  * No charge may be made beyond the normal charges of a PD library /
  43.    magazine, etc.
  44.  * All original files must be included in the distribution, in an
  45.    unmodified form.
  46.  * The author can accept no responsibility for any problems arising from
  47.    use of this software. No guarantee is given for the suitability or
  48.    usability of this software.
  49.  
  50. Magazine editors and CD-ROM publishers are kindly requested to contact
  51. the original author before distributing Qedit.
  52.  
  53.  
  54. 2. Requirements
  55. ---------------
  56.  
  57. Operating System:
  58.  * RISC OS 3.10 or greater
  59.  
  60. Software:
  61.  * Newsbase (except for ANT suite, although the editting is crude without it)
  62.  
  63. One or more of the following programs:
  64.  * NewsHound
  65.  * FreeNews
  66.  * FreeSMTP
  67.  * POP
  68.  * POPstar
  69.  * ka9q (TCP/IP)
  70.  * The ANT internet suite
  71.  * Termite Internet
  72.  
  73. Newsbase is available from:
  74.  
  75. http://www.hep.umn.edu/~allan/newsbase/
  76.  
  77. The PD/freeware programs should be available from:
  78.  
  79. http://freenet.barnet.ac.uk/freenet/
  80.  
  81. If you don't have Newsbase, you will be unable to edit outgoing messages,
  82. but you will still be able to use the other options. (Although editting
  83. messages when the ANT suite is in use will work, although you have are
  84. presented the raw message file to edit.)
  85.  
  86.  
  87. 3. Running Qedit
  88. ----------------
  89.  
  90. Qedit should be installed in the same directory as NewsBase.
  91. If you're not using NewsBase, you will need to configure the qedit
  92. manually so it knows what transports you use. See section 8.
  93.  
  94. There are three ways of runnning Qedit:
  95.  
  96. i)   Double click on it directly.
  97. ii)  Use the "Show Queues..." option in Newsbase.
  98. iii) Use an option in TCPIP's macros menu (version 1.02 or greater have
  99.      this already set up).
  100.  
  101. When you run Qedit, it will take a second or two to scan your outgoing
  102. queues. If it cannot find your mail directory (for the current outgoing
  103. transports), then it will complain and quit. Otherwise the main window
  104. will open.
  105.  
  106. Using Zap's Email mode:
  107.  
  108.   You can make Zap use the Email editing mode when re-editing messages. Open
  109.   up the Zap Keys file, and add the following line after the &5nn lines:
  110.  
  111.   &5nn   &FFF    \#\*.Re-edit           +Email
  112.  
  113.   where &5nn is a hexadecimal number different to the other &5nn numbers.
  114.   
  115.   This line is already present in Zap version 1.35.
  116.  
  117. Finally, a note on memory:
  118.  
  119.   The wimpslot is the runfile is set at 60k - if you get "No room" errors,
  120.   load !Qedit.!Run into an editor, and increase this figure (to, say 80k).
  121.  
  122.  
  123. 4. The main window
  124. ------------------
  125.  
  126. This window shows all messages that will be sent next time you connect to
  127. your service provider.
  128.  
  129. The first column (headed Type) shows whether the message is Mail or News. If 
  130. it is "on hold" (see section 5), a red message will appear here as well.
  131.  
  132. The second column is headed ID, and is a unique identifier for that message.
  133. You will only need to know this if you want to manually alter a message.
  134.  
  135. The third column is the size of the message in bytes, including headers. This
  136. is shown in bytes, or kilobytes if suffixed with "k".
  137.  
  138. The fourth and fifth columns indicate the time and date at which the message
  139. was last edited.
  140.  
  141. The final column shows who the message is from, the subject, and the
  142. destination (either an e-mail address for mail, or a newsgroup for news).
  143.  
  144. The last column will be truncated if it is too long, and terminated by an
  145. ellipsis. (...)
  146.  
  147. Mailing list messages sent by !MailList are now shown in blue.
  148.  
  149.  
  150. 5. Messages "on hold"
  151. ---------------------
  152.  
  153. If you have written a message, but you don't want it to be sent off
  154. immediately, you can put it "on hold". This prevents your internet software
  155. from sending it when you next connect to your service provider.
  156.  
  157. This can be useful if you want time to think over what you have said, or
  158. if you wish to delay posting of a message.
  159.  
  160. To put a message on hold, click ADJUST on it, or choose the menu item "Hold".
  161. To release it, click ADJUST again, or choose the menu item "Release".
  162.  
  163. Messages that are on hold are listed with a red "HELD" message on the queues
  164. display.
  165.  
  166. At Charterhouse School this is used for mail approval. Messages sent by pupils
  167. are automatically put on hold until the system manager "approves" them by
  168. releasing them. This is done with modified Newsbase transport files.
  169.  
  170.  
  171. 6. Re-editing messages
  172. ----------------------
  173.  
  174. To re-edit a message, simply click on it with SELECT. Assuming a suitable
  175. text editor can be found (e.g. !Edit or !Zap), a window containing the
  176. message will appear. You may then edit it as you please.
  177.  
  178. Once you have finished, simply save the file (without changing the filename),
  179. and then close the window. Qedit will detect that you have finished, and
  180. repost the message through Newsbase. If you don't want to save the changes,
  181. simply close the window and discard the file.
  182.  
  183. Note that you can only edit one message at a time, and that it will be
  184. automatically put "on hold" to stop it being sent while you're editing it.
  185. Do not quit !qedit whilst editing a message.
  186.  
  187. Read section 9 for restrictions on blind carbon copies.
  188.  
  189.  
  190. 7. Other options
  191. ----------------
  192.  
  193. To delete a message, choose the menu option "Item-->Delete". You will be
  194. prompted for confirmation. Click OK to delete the item, or Cancel to leave
  195. it intact. If you don't want to be asked for confirmation each time, you can
  196. turn it off (see section 8).
  197.  
  198. If you delete a message by mistake, you may find it in the
  199. Email.<username>.outgoing.mail/news folders, if you have enabled this feature
  200. in Newsbase.
  201.  
  202. Qedit will normally update the display automatically when messages are added
  203. or removed, but to force a rescan of your outgoing queues, choose the menu
  204. option "Re-check queues".
  205.  
  206. To remove everything from the outgoing queues (including held messages)
  207. choose the menu item "Flush queues". You will be asked for confirmation once,
  208. even if you have turned confirmation off (see section 8).
  209.  
  210. To leave Qedit simply click SELECT on the window's close icon, or choose the
  211. menu option "Quit".
  212.  
  213.  
  214. 8. Configuration
  215. ----------------
  216.  
  217. Configuration of Qedit is made by editing the Messages file. Open up the
  218. !Qedit application directory and load the Messages file into your favourite
  219. text editor.
  220.  
  221. Transports:
  222.    If Qedit is unable to automatically detect your transports, you
  223.    should locate the lines beginning "mail:" and "news:" and change
  224.    their values according to the instructions given just above them.
  225.  
  226. Scrap file:
  227.    By default, Qedit uses the Wimp !Scrap directory to store messages
  228.    whilst they are edited. If this is inconvient, locate the line
  229.    beginning "scrap:" and alter its contents.
  230.  
  231. Confirmation:
  232.    If you do not wish to be asked for confirmation each time you delete an
  233.    outgoing message, locate the line beginning "confirm:" and change the "Y"
  234.    to a "N".
  235.  
  236.  
  237. 9. Known problems
  238. -----------------
  239.  
  240. If you edit a mail message which originally had blind-carbon-copy (Bcc:)
  241. recipients, these will not be put back into the editing window. If you want
  242. to keep them, you must type them back manually by adding a Bcc: line
  243. to the headers, e.g.:
  244.  
  245. To: johnny@white.com
  246. Cc: fred@bloggs.co.uk
  247. Bcc: harry@infotrek.co.uk    <- You must type this line back in yourself.
  248.  
  249. I can't see any way of doing this automatically at the moment, but I will
  250. keep trying!
  251.  
  252. This especially applies to mailing list messages. If you edit a mailing list
  253. message, it will be sent back to your site to be re-distributed. This is not
  254. a problem, it just means distribution will be a little slower.
  255.  
  256. Also, if you try to repost a message while Newsbase is busy (e.g. during a
  257. debatch or expiry) the message may be lost, although you can find it in your
  258. !Scrap directory.
  259.  
  260.  
  261. 10. Wish-list
  262. -------------
  263.  
  264.  * Saving a queue report (simply a transcript of the window)
  265.  * Check with the user when receiving PreQuit while editing.
  266.  * Calculate the correct boundaries in Redraw loop to speed it up.
  267.  * Fix quit-handling - have a rescue option and store all the type/id
  268.    info inside the scrapdir.
  269.  * Handle "try again later" message correctly.
  270.  * Insert Bcc: lines before re-editing
  271.  * Scan work files as well as text files when showing queue - otherwise
  272.    you get worrying messages when SMTP trys to send a work-file-only message.
  273.  * Check lock files.
  274.  * A "Rescue" option, ala TTFN.
  275.  * Use OS_ConvertFileSize
  276.  
  277. This is an interim release of Qedit.
  278.  
  279. The next version of Qedit is well underway and supports numerous transports
  280. concurrently. See http://www.infotrek.demon.co.uk/freeware/qedit/
  281.  
  282.  
  283. 11. Release history
  284. -------------------
  285.  
  286. 0.01Þ (22-Jan-95)
  287.  / initial idea, sent to Graham Allan
  288.  
  289. 0.50ß (25-Jan-95)
  290.  * re-write of loading/redrawing code - and now uses Wimp icons for column
  291.    separators rather than drawing them myself (much faster)
  292.  * uses the text files rather than work files to scan queues
  293.  / sent to beta-testers
  294.  
  295. 0.51ß (31-Jan-95)
  296.  * asks for confirmation if you try to quit whilst editing
  297.  * gives an informative message if it can't find a text editor (rather than
  298.    just assuming it's being edited) (you now need RISC OS 3.10 or greater)
  299.  * command-line options -debug and -noconfirm added
  300.  * Individual icons for the column headers to make it RiscPC-friendly
  301.  * Will automatically update queues when a message is sent through Newsbase
  302.    version 0.52e or greater. Up to 50 extra messages can be added before a
  303.    reload of Qedit is required. If you are editing, this is done when you
  304.    have finished editing, otherwise it is done immediately.
  305.  * Broadcasts the update message when an message is held/released/deleted to
  306.    allow other queue programs and Newsbase to update.
  307.  * Tidied up Wimp message handling
  308.  * Remembers the message you're editing by it's ID, rather than its position
  309.    in the window. This means:
  310.     a) It doesn't lose track after a QueueUpdate message.
  311.     b) You can now delete/hold/release any message that is not being edited.
  312.  * Menu options "Help", "Re-check queues" and "Flush queues" added.
  313.  * Fixed re-opening of menus.
  314.  * Truncates "To:" and "From:" lines in mail messages if they are too long.
  315.  / sent to beta-testers
  316.  
  317. 0.52ß (05-Feb-95)
  318.  * Fixed bug that stopped the info for news articles being displayed. (there
  319.    was a spurious ENDIF hanging around)
  320.  * Widened the ID column as I discovered news ID's could be 6 long (but are
  321.    limited to 6 as they are preceded by "news". Mail shouldn't be a problem;
  322.    if you have sent 999,999 messages you can jolly well change your sequence
  323.    file!)
  324.  * When you've finished re-editing, the message is now posted through Newsbase
  325.    (if you change it). This removes the restriction on To:, Cc: and Bcc:
  326.    changing. (This means you now need Newsbase to edit messages)
  327.  * Now has a multi-tasking message window for non-serious errors, in the same
  328.    style as Newsbase. (centralised on screen)
  329.  * Now uses MessageTrans for nearly all non-debug text.
  330.  * Checks the edit window whenever the main window is asked to redraw, so
  331.    that it can usually detect the window close immediately. Also checks
  332.    every 50cs.
  333.  * Interactive help added.
  334.  * Fixed "Re-check queues" while TCPIP is sending mail.
  335.  / sent to betatesters
  336.  
  337. 0.53 (08-Feb-95)
  338.  * Removed all debugging code. -debug command-line option removed.
  339.  * General tidy up.
  340.  / sent to Dr. Alan Hassey
  341.  
  342. 0.54 (16-Feb-95)
  343.  * Stops you loading more than one copy - if you try, it brings the original
  344.    copy back to the front.
  345.  * Now inserts filename into a desktop boot file if you use the Desktop Boot
  346.    option from the Task Manager.
  347.  * Messages greater than 50 kilobytes long now have their size displayed in
  348.    kilobytes instead of bytes.
  349.  * Moved "-noconfirm" into Messages file.
  350.  * Changed wimpslot from 128k to 64k. Fixed display updating when memory short
  351.  * Easier installation method.
  352.  / Uploaded to ftp.demon.co.uk
  353.  
  354. 0.54a (03-Mar-95)
  355.  * Now gives you info if Newsbase cannot execute a particular command.
  356.  / sent to those with communications erros, and uploaded to Arcade BBS
  357.  
  358. 0.55 (13-Jul-95)
  359.  * Transport name can be changed in the Messages file. (e.g. "old-ka9q")
  360.  * System$Path_Message used to ensure !System if it is needed, but not
  361.    complain if it isn't. (been flicking through the PRMs...)
  362.  * MailList messages are shown in blue (It checks the X-MailList: header)
  363.  * No longer asks confirmation for delete if message is being edited.
  364.  * Tidied newsbase communications & moved more text into Messages
  365.  * Checks for bad work files rather than give EOF errors.
  366.  * More informative "Newsbase not found" errors, and it tells you where you
  367.    can find lost files.
  368.  * Now says "edit" rather than "HELD" when editing an un-held message.
  369.  * Uses OS_FSControl rather than *Wipe *Copy and *Rename (avoids problems
  370.    with Bits module).
  371.  * Checks to see whether the editing window is _open_ rather than just
  372.    deleted - this *may* fix a problem with Zap 1.30.
  373.  * !RunImage squashed.
  374.  * WimpSlot reduced to 32k - but if you have more than ~30 messages you will
  375.    need to put it back to 64k in the !Run file.
  376.  / to mnhepw.hep.umn.edu, ftp.demon.co.uk and micros.hensa.ac.uk
  377.  
  378. 0.56 (21-Jul-95)
  379.  * Problem with Newsbase 0.55 fixed - Newsbase now automatically appends a
  380.    Sender: header if it believes the From: header to be incorrect. To
  381.    compensate, Qedit now sets the user to whatever the From: header says.
  382.    This will probably also cure the "cannot post article" errors.
  383.  / to mnhepw.hep.umn.edu and ftp.demon.co.uk
  384.  
  385. 0.57 (12-Jul-96) bugfix release
  386.  * Menu no longer gets screwed up by long message filenames
  387.  * ID column now truncated to last 6 characters of filename
  388.  * "Approved" messages shown in green
  389.  * Updated memory reservation
  390.  * Fixed "String too long" error on startup
  391.  / patch upgrade to usual sites
  392.  
  393. 0.58-dev-60 (30-Apr-97) First release with support for other transports
  394.                  Changes made by Joseph Heenan
  395.  * Support adding for the following newsbase transports:
  396.    * FreeSMTP
  397.    * POP
  398.    * NewsHound
  399.    * FreeNews
  400.    * ANT (email & news)
  401.    * Termite (email & news)
  402.  * Removed bug in parsing From: line
  403.      (Joseph <jogu@.. was interpreted as user Joseph)
  404.  * Changed update routines so they trigger when newsbase says any
  405.      transport queue has been modified.
  406.      (newsbase does not seem to be providing the right transport name)
  407.  * Now ignores queue entries that cannot be read for some reason
  408.      (eg. are currently been sent)
  409.  * Now uses registered newsbase wimp messages numbers
  410.  * Auto transport detection
  411.  
  412. 0.58-dev-61 (03-May-97) Joseph
  413.  * Queue window template changed so it looks better with a desktop
  414.      outline font.
  415.  * Now sets filetypes to text before passing them to an editor
  416.      (this use to stop freesmtp edits coming up in Email mode in Zap)
  417.  * Warns when you try to edit a message that is currently being sent
  418.  * Flags messages that are in the process of been sent
  419.  * Edit / hold cope if the message vanishes under them
  420.  * mail command to newsbase was using old style message
  421.  
  422. 0.58 (12-May-97) Joseph
  423.  * Will now strip out surplus Received: headers. Fixes problems with
  424.      FreeSMTP. Also strips out Sender: header.
  425.  * Now parses email and uses Sender: header (if present) rather than
  426.      From: header to set newsbase user. (fixes user masquerading prob.)
  427.  * Removed a surplus ')' from a line detecting the ANT suite
  428.  * Configuration of transports is now made in the Messages file (DC)
  429.  * Text moved to Messages file (DC)
  430.  / Released to usual sites
  431.  
  432. 0.58a (20-May-97) Joseph
  433.  * Fixed String too long error when reading work file
  434.    (Line 711, change 255-LEN(b$(b5... to 250-LEN... )
  435.  * Fixed long line truncation in edit copy
  436.  
  437. 0.58b (22-May-97) Joseph
  438.  * Added code to close openfiles when errors occur
  439.  * Improved error handling for open files (especially when deleting msgs)
  440.    (Fixing bad interaction with longfilenames module in the process)
  441.  
  442. 0.58c (24-May-97) Joseph
  443.  * Fixed ANT suite editting (double line spaced)
  444.  * Made changes so it interacts with newsbase 0.59 better
  445.  
  446. 0.58d (11-Jul-97) Joseph
  447.  * Changed Messages slightly (no !newsdir message)
  448.  * Changed so it defaults to ANT if no !newsdir found
  449.  
  450. 0.58e (17-Jul-97) Joseph
  451.  * If the ANT transports are in use, and newsbase is not loaded,
  452.    editting a message will bring up the raw message in the editor.
  453.  
  454. 0.58f (28-Jul-97) Joseph
  455.  * Fixed handling of local errors whilst loading & fatal errors during
  456.    startup
  457.  * Fixed non-removal of '.' when bringing an ANT message into Re-edit
  458.  
  459. 0.58g (01-Aug-97) Joseph
  460.  * Fixed extra CR's at end of ANT messages
  461.  
  462. 0.58h (01-Aug-97) Joseph
  463.  * Attempted fix at blank lines
  464.  
  465. 0.58i (25-Feb-98) Joseph
  466.  * Added POPstar support
  467.  
  468. 12. Acknowledgements
  469. --------------------
  470.  
  471. I would like to thank Adam Goodfellow, Graham Allan and Tom Hughes for their
  472. advice on earlier versions. Also to Joseph Heenan who has been hard at work
  473. to produce this multi-transport version.
  474.  
  475. Thanks also to the following for beta testing the multitransport
  476. version for Joseph:
  477.     Ruth Gunstone           Andy Fawcett
  478.     Graham Allan            Tony Houghton
  479.     Carol Carpenter         Andrew Black
  480.  
  481.  
  482. 13. Contact addresses
  483. ---------------------
  484.  
  485. * The support for transports other than ka9q was added by Joseph Heenan, *
  486. * joseph@ping.demon.co.uk. Problems with this version of !qedit          *
  487. * should be sent to Joseph.                                              *
  488.  
  489.  
  490. If you have any suggestions for the development of this program, or have
  491. found any problems with it, please tell me. My e-mail address is
  492. <david@infotrek.demon.co.uk>
  493.  
  494. Qedit is on the WWW at http://www.infotrek.demon.co.uk/freeware/qedit/
  495.  
  496.